'\" t
.\" ** The above line should force tbl to be a preprocessor **
.\" Man page for xeno-config
.\"
.\" Copyright (C) 2005 Romain Lenglet <rlenglet@users.forge.objectweb.org>
.\"
.\" You may distribute under the terms of the GNU General Public
.\" License as specified in the file COPYING that comes with the
.\" Xenomai distribution.
.\"
.pc
.TH XENO-CONFIG 1 "2005-10-18" "@PACKAGE_VERSION@" "Xenomai"
.SH NAME
xeno-config \- Display Xenomai libraries configuration
.SH SYNOPSIS
.\" The general command line
.B xeno-config
.br
\fBxeno-config\fP \fB\-\-v\fP | \fB\-\-verbose\fP
.br
.B xeno-config \-\-help
.br
\fBxeno-config\fP [\fB\-\-version\fP] [\fB\-\-cc\fP] [\fB\-\-cross\-compile\fP] [\fB\-\-arch\fP] [\fB\-\-subarch\fP] [\fB\-\-prefix\fP] [\fB\-\-config\fP] [\fB\-\-mod*\-cflags\fP|\fB\-\-module\-cflags\fP|\fB\-\-kernel\-cflags\fP] [\fB\-\-xeno\-cflags\fP|\fB\-\-fusion\-cflags\fP] [\fB\-\-xeno\-ldflags\fP|\fB\-\-fusion\-ldflags\fP] [\fB\-\-posix\-cflags\fP] [\fB\-\-posix\-ldflags\fP] [\fB\-\-uvm\-cflags\fP] [\fB\-\-uvm\-ldflags\fP] [\fB\-\-linux\-dir\fP|\fB\-\-linux\fP] [\fB\-\-linux\-ver*\fP|\fB\-\-linux\-version\fP] [\fB\-\-mod*\-dir\fP|\fB\-\-module\-dir\fP] [\fB\-\-sym*\-dir\fP|\fB\-\-symbol\-dir\fP] [\fB\-\-lib*\-dir\fP|\fB\-\-library\-dir\fP|\fB\-\-libdir\fP|\fB\-\-user\-libdir\fP]
.SH DESCRIPTION
\fBxeno-config\fP is a script that is used to to display the compiler and linker flags that are required for building applications that use Xenomai.
Any combination of options can be chosen (except \fB\-\-verbose\fP and \fB\-\-help\fP) to display configuration information, and options can be given in any order.
The command output one line for each option, in the same order as the options.

When \fBxeno-config \-\-verbose\fP is executed, all configuration information is displayed in a different, human-readable format.

When \fBxeno-config\fP is executed without any options, the output is equivalent to than when executing \fBxeno-config \-\-verbose\fP then \fBxeno-config \-\-help\fP.

.\" ********************************************************************
.SH OPTIONS
In an option's description, a \fB*\fP in the option name is meant as a wildcard. For instance, \fB\-\-mod\-cflags\fP, \fB\-\-modu\-cflags\fP and \fB\-\-modanything\-cflags\fP are all valid and synonymous options.
.TP
.B \-\-v, \-\-verbose
Outputs all configuration information, in a human-readable format.
.TP
.B \-\-help
Outputs the list of available command-line options.
.TP
.B \-\-version
Outputs one line with the installed Xenomai version.
.TP
.B \-\-cc
Outputs one line with the path to the C compiler command used to compiled Xenomai.
.TP
.B \-\-cross\-compile
Outputs one line with the prefix that was prepended to the command names used to compile Xenomai, e.g. if it was cross-compiled.
The ouput line is empty if no prefix was prepended to command names.
.TP
.B \-\-arch
Outputs one line with the architecture to compile to, e.g. i386.
.TP
.B \-\-subarch
Outputs one line with the sub-architecture to compile to.
The ouput line is empty if not compiling to a specific sub-architecture.
.TP
.B \-\-prefix
Outputs one line with the absolute path to the base Xenomai installation directory.
.TP
.B \-\-config
Outputs one line with the absolute path to the configuration file used to compile Xenomai.
.TP
.B \-\-mod*\-cflags, \-\-module\-cflags, \-\-kernel\-cflags
Outputs one line with the C compiler command-line options that are necessary to compile Linux kernel modules that use the Xenomai Linux kernel modules.
.TP
.B \-\-xeno\-cflags, \-\-fusion\-cflags
Outputs one line with the C compiler command-line options that are necessary to compile applications that use the Xenomai libraries.
The \fB\-\-fusion\-cflags\fP option variant is for backward compatibility only, to be used to compile RTAI/Fusion-based applications.
.TP
.B \-\-xeno\-ldflags, \-\-fusion\-ldflags
Outputs one line with the C compiler command-line options that are necessary to link applications against the Xenomai libraries.
The \fB\-\-fusion\-ldflags\fP option variant is for backward compatibility only, to be used to link RTAI/Fusion-based applications.
.TP
.B \-\-posix\-cflags
Outputs one line with the C compiler command-line options that are necessary to compile applications that use Xenomai's Posix-compatible layer library.
.TP
.B \-\-posix\-ldflags
Outputs one line with the C compiler command-line options that are necessary to link applications against Xenomai's Posix-compatible layer library.
.TP
.B \-\-uvm\-cflags
Outputs one line with the C compiler command-line options that are necessary to compile applications that use Xenomai's User-space Virtual Machine library.
.TP
.B \-\-uvm\-ldflags
Outputs one line with the C compiler command-line options that are necessary to link applications against Xenomai's User-space Virtual Machine library.
.TP
.B \-\-linux\-dir, \-\-linux
Outputs one line with the absolute path to the Linux kernel sources used to compile Xenomai.
.TP
.B \-\-linux\-ver*, \-\-linux\-version
Outputs one line with the version of the Linux kernel Xenomai has been compiled against.
.TP
.B \-\-mod*\-dir, \-\-module\-dir
Outputs one line with the absolute path to Xenomai's kernel modules.
This path may be different from the path to the stock Linux kernel modules.
.TP
.B \-\-sym*\-dir, \-\-symbol\-dir
Outputs one line with the absolute path to the directory of Xenomai's kernel modules symbol files.
This path may be different from the path to the symbol files of the stock Linux kernel modules.
.TP
.B \-\-lib*\-dir, \-\-library\-dir, \-\-libdir, \-\-user\-libdir
Outputs one line with the absolute path to Xenomai's libraries.
.SH "ENVIRONMENT VARIABLES"
.TP
.B DESTDIR
If the \fBDESTDIR\fP variable is set, its content is prepended to the Xenomai installed directories and files names output by the
\fB\-\-prefix\fP, \fB\-\-config\fP, \fB\-\-module\-dir\fP, \fB\-\-symbol\-dir\fP and \fB\-\-library\-dir\fP
options, and to the Xenomai installation directories in the flags output by the
\fB\-\-kernel\-cflags\fP, \fB\-\-xeno\-cflags\fP, \fB\-\-xeno\-ldflags\fP, \fB\-\-posix\-cflags\fP, \fB\-\-posix\-ldflags\fP, \fB\-\-uvm\-cflags\fP and \fB\-\-uvm\-ldflags\fP
options.

If \fBDESTDIR\fP was set when compiling and installing Xenomai, e.g. for cross-compilation, \fBDESTDIR\fP must be set to the same value before calling \fBxeno-config\fP, in order to output valid directory and file names.
.SH "RETURN CODES"
.TP
.B 0
Successful script execution.
.TP
.B 1
The
.B \-\-posix\-ldflags
option has been given but Posix support is not available in Xenomai,
or no option has been given on the command-line.
.SH HISTORY
2005-10-18 \- Written by Romain Lenglet <rlenglet@users.forge.objectweb.org>
